Request For Return Response

The ReturnRequestResponse API enables to repond the respective payment return request (RFR_IN) from the sender.

Method: POST

{{URL}}/rtp/rpc/TransactionService/ReturnRequestResponse

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
caseId Mandatory	String Case ID that comes in inbound request Example – "CBWQA2023082300000569"
referenceNumber Mandatory	String Reference number of the original transaction Example – "202308232670841311Sy07vNbkXW7HtK"
paymentReferenceNumber Mandatory	String Reference number of new payment, if the status is ‘IPAY' or ‘PECR' Example – "CBWREF2023081700000016"
remarks Mandatory	String Remarks given for this response Example – "Payment information"
reason Mandatory	String Remarks given for this response Reason provided, if the status of pending response is PDCR/RJCR/PECR Example – "LEGL"
status Mandatory	String Status of the response for the request Example – "PDCR"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW" or "TCH"
settlementAmount Mandatory	Object
amount Mandatory	Number Amount to be returned for request on original transaction Example – 500
currency Mandatory	String Currency code in which the transaction happens Example – "USD"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/ReturnRequestResponse' \
--header 'Content-Type: application/json' \
--data '{"caseId":"M20240328987654322T1BTST45424603611","status":"IPAY","referenceNumber":"M20240328990000001T1BTST39398303611","paymentReferenceNumber":"PAYREF898765654354655457","processor":"TCH"}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/ReturnRequestResponse", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""caseId"": ""M20240328987654322T1BTST45424603611"",
" + "\n" +
@"    ""status"": ""IPAY"",
" + "\n" +
@"    ""referenceNumber"": ""M20240328990000001T1BTST39398303611"",
" + "\n" +
@"    ""paymentReferenceNumber"": ""PAYREF898765654354655457"",
" + "\n" +
@"    ""processor"": ""TCH""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/ReturnRequestResponse"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "caseId": "M20240328987654322T1BTST45424603611",`+"
"+`
    "status": "IPAY",`+"
"+`
    "referenceNumber": "M20240328990000001T1BTST39398303611",`+"
"+`
    "paymentReferenceNumber": "PAYREF898765654354655457",`+"
"+`
    "processor": "TCH"`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/ReturnRequestResponse',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "caseId": "M20240328987654322T1BTST45424603611",
  "status": "IPAY",
  "referenceNumber": "M20240328990000001T1BTST39398303611",
  "paymentReferenceNumber": "PAYREF898765654354655457",
  "processor": "TCH"
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

//For status - IPAY
{
    "caseId": "CBWQA2023082300000569",
    "referenceNumber": "202308232670841311Sy07vNbkXW7HtK",
    "paymentReferenceNumber": "CBWQARRR2023082300001",
    "remarks": "Payment information",
    "status": "IPAY",
    "processor": "FEDNOW"
}
//For status - PECR
{
    "caseId": "CBWQA2023082300000569",
    "referenceNumber": "202308232670841311Sy07vNbkXW7HtK",
    "paymentReferenceNumber": "CBWQARRR2023082300001",
    "remarks": "Payment information",
    "status": "PECR",
    "processor": "FEDNOW",
    "settlementAmount": {
        "amount": 500,
        "currency": "USD"
    }
}
//For status - PDCR
{
    "caseId": "CBWQA2023082300000570",
    "referenceNumber": "202308232670841311Sy07vNbkXW7HtK",
    "remarks": "Awaiting reason",
    "reason": "LEGL",
    "processor": "FEDNOW",
    "status": "PDCR"
}
//For status - RJCR
{
    "caseId": "CBWQA2023082300000570",
    "referenceNumber": "202308232670841311Sy07vNbkXW7HtK",
    "remarks": "Awaiting reason",
    "reason": "LEGL",
    "status": "RJCR",
    "processor": "FEDNOW",
}

Response: 200

Response Parameters

Parameter	Description
response	String Response received for the given request Example – "JSON Representation of Received Response"
message	String Notification message for the transaction Example – "Transfered Successfully"
transactionID	String Unique ID generated for the transaction Example – "20240328026013673T1B3VUQ83277803611"
endToEndId	String ID that enables to trace the transaction at any time during the process Example – "PAYREF898765654354655458"
instructingId	String Payment reference ID of the transaction Example – "20240328026013673T1B3VUQ83277803611"
messageId	String Unique message ID generated for the transaction Example – "M20240328026013673T1BISP83277803611"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
status	String Current status of the transaction Example – "ACTC"
acceptedDate	String Date and time of the transaction was processed Example – "2024-03-28T13:01:17"
settlementDate	String Date and time of the transaction was completed Example – "2024-03-28"
windowId (Applicable only for TCH)	String Unique ID used for reconciliation of transactions Example – "001"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "Transfered Successfully",
  "transactionID": "20240328026013673T1B3VUQ83277803611",
  "endToEndId": "PAYREF898765654354655458",
  "instructingId": "20240328026013673T1B3VUQ83277803611",
  "messageId": "M20240328026013673T1BISP83277803611",
  "rawMessage": "Base64 Value of Received Response",
  "status": "ACTC",
  "acceptedDate": "2024-03-28T13:01:17",
  "settlementDate": "2024-03-28",
  "windowId": "001" //applicable only for TCH
}